Do:

• Set the goals of the project
• Define current state
• Specific Features
• System agnostic
• Define success
• Set a time line

Dont:

• Leave ambiguity final product
• Define exact process
• Leave Success metrics up to interpretation

Documentation

• 1 Specification Family : 1 file

• Record pertinent information

• Detail

  • Spec
  • Measureables
  • success

#' @title Function Specifications 001
#' @section Last updated by:
#' Ellis Hughes
#' @section Last updated date:
#' 2020-1-27
#' 
+ _Specifications_
  + 1.1 Presentation must explain validation procedure.
  + 1.2 Be entertaining.
  + 1.3 Inform and document each step necessary for success.
  + 1.4 Fame and Glamour.

Step One

• Define function requirements

• Modularity

SOME SORT OF IMAGE/GIF

Supporting Cast

• Roxygen Documentation

• Unit Tests

SOME SORT OF IMAGE/GIF

Advantages of SCM

• Branching

• Detailed code Review

  • Style guides

Documentation

• Name
• Purpose
• Arguments
• Example
• Validation Requirements

#' @title Function Name
#' @description 
#'    Description of great function
#' @section Last updated by:
#' Ellis Hughes
#' @section Last updated date:
#' 2020-1-27
#' @param arg1 argument 1
#' @param arg2 argument 2
#' @example
#' output <- sample_function(1,2)
#' 
#' @export

sample_function <- function(arg1, arg2){
  temp_object <- arg1 * arg2
  return(temp_object)
}

What are they

• Not Unit or Regression tests

• Draw connections between Specifications and Code

How to write

• Detailed without writing code

• How do all the pieces actually work together

A case for Test Coding

• Resolves interpretation errors in documentation and test cases

• 3rd party to code

  • Does not have preconceived idea of function

• Identify improvements

Formatting

• Test that format
• Combine with Roxygen comments
• Breaking out
  • each family of tests into a file
  • each sub-test as a testthat case